Skip to content

build: add test-coverage script #10894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Aug 25, 2025
Merged

build: add test-coverage script #10894

merged 2 commits into from
Aug 25, 2025

Conversation

ryzhak
Copy link
Contributor

@ryzhak ryzhak commented Jul 1, 2025

This PR adds a new test-coverage script to makefile which runs unit/doc tests and generates an html report locally in the target/llvm-cov/html folder.

This way it's easier to see parts of code which could be better covered with tests.

Notice that the displayed line coverage right now is 62.28% but that's not an accurate value because llvm-cov counts all unit tests in mod tests modules as uncovered code. Those unit tests should be manually excluded from the coverage report (which could be a part of another issue if collecting test coverage lies within the project vision):

#[cfg(test)]
#[cfg_attr(coverage_nightly, coverage(off))]
mod tests {
    // ...
}

@mattsse mattsse requested a review from 0xrusowsky as a code owner August 25, 2025 13:42
@DaniPopes DaniPopes enabled auto-merge (squash) August 25, 2025 13:44
@DaniPopes DaniPopes merged commit 5c99c90 into foundry-rs:master Aug 25, 2025
22 checks passed
@github-project-automation github-project-automation bot moved this to Done in Foundry Aug 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@onbjerg onbjerg onbjerg approved these changes

@DaniPopes DaniPopes DaniPopes approved these changes

@klkvr klkvr Awaiting requested review from klkvr klkvr is a code owner

@mattsse mattsse Awaiting requested review from mattsse mattsse is a code owner

@grandizzy grandizzy Awaiting requested review from grandizzy grandizzy is a code owner

@yash-atreya yash-atreya Awaiting requested review from yash-atreya yash-atreya is a code owner

@zerosnacks zerosnacks Awaiting requested review from zerosnacks zerosnacks is a code owner

@0xrusowsky 0xrusowsky Awaiting requested review from 0xrusowsky 0xrusowsky is a code owner

Assignees
No one assigned
Labels
None yet
Projects
Foundry
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ryzhak @onbjerg @DaniPopes @mattsse